/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.beam.sdk.values;

import java.util.Collection;
import org.apache.beam.sdk.transforms.windowing.BoundedWindow;
import org.apache.beam.sdk.transforms.windowing.PaneInfo;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.joda.time.Instant;

/**
 * A builder for an output, to set all the fields and extended metadata of a Beam value.
 *
 * <p>Which fields are required or allowed to be set depends on the context of the builder.
 *
 * <p>It is allowed to modify an instance and then call {@link #output()} again.
 *
 * <p>Not intended to be implemented by Beam users. This interface will be expanded in ways that are
 * backwards-incompatible, by requiring implementors to add methods.
 */
public interface OutputBuilder<T> extends WindowedValue<T> {
  OutputBuilder<T> setValue(T value);

  OutputBuilder<T> setTimestamp(Instant timestamp);

  OutputBuilder<T> setWindow(BoundedWindow window);

  OutputBuilder<T> setWindows(Collection<? extends BoundedWindow> windows);

  OutputBuilder<T> setPaneInfo(PaneInfo paneInfo);

  OutputBuilder<T> setRecordId(@Nullable String recordId);

  OutputBuilder<T> setRecordOffset(@Nullable Long recordOffset);

  OutputBuilder<T> setCausedByDrain(boolean causedByDrain);

  void output();
}
